/* ===================

AX2E (AXESCON XACML 2.0 Engine) is the Java authorization engine, which implements OASIS XACML 2.0 standard.
Copyright (C) 2007 AXESCON LLC

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA


Contact: AXESCON LLC - info{at}axescon.com

 =================== */
package axescon.xacml.api;

import axescon.xacml.model.ctx.Attribute;
import axescon.xacml.model.ctx.AttributeValue;
import axescon.xacml.model.ctx.XacmlCtx;


/**
 * @author argyn
 *         Date: Jun 26, 2005
 *         Time: 12:27:54 PM
 *         Responsibilities: represents XACML Context Handler. See ch. 3.1 of XACML 2.0 specification document.
 * This is AXESCON XACML Engine's extensibility point. Custom context handlers should extend this interface.
 */
public interface CtxHandler {


//    AttributeValue getResourceAttribute(XacmlCtx req, String id);

    /**
     * retrieves resource Id from resource. it assumes there's only one resource, and it has
     * only one resource id attribute value
     *
     * todo: support multiple resources
     *
     * @param req request reference
     * @return resource-id String
     */
    String getResourceId(XacmlCtx req);

    /**
     * retrieves Environment attributes from request
     * @param req request
     * @return array of Environment attributes
     */
    Attribute[] getEnvironmentAttributeArray(XacmlCtx req);

    /**
     * retrieves Action attributes from request
     * @param req request
     * @return array of Action attributes
     */
    Attribute[] getActionAttributeArray(XacmlCtx req);

    /**
     * retrieves Resource attributes from request
     * @param req request
     * @return array of Resource attributes
     */
    Attribute[] getResourceAttributeArray(XacmlCtx req);

    /**
     * retrieves Subject attributes from request
     * @param req request
     * @return array of Subject attributes
     */
    Attribute[] getSubjectAttributeArray(String attributeId, String category, XacmlCtx req);
}
